Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ENH: Improve calc_measured_loc performance and support #57

Merged
merged 8 commits into from
Sep 16, 2021

Conversation

aburrell
Copy link
Member

Description

Expands the applicability of the pysatMadrigal.instruments.methods.jro.calc_measured_loc routine to more az/el variable names, adds an example to the docs, and adds unit tests for pysatMadrigal.instruments.methods.jro.

Partially addresses #3 and #41.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality or documentation)
  • This change requires a documentation update

How Has This Been Tested?

Created an example, which you can follow along in ex_jro_isr_beam.rst to reproduce a figure. Also added unit test to test_methods_jro.py.

Test Configuration

  • Operating system: OS X Mojave
  • Version number: Python 3.9
  • Any details about your local setup that are relevant

Checklist:

  • Make sure you are merging into the develop (not main) branch
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have linted the files updated in this pull request
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • Add a note to CHANGELOG.md, summarizing the changes

If this is a release PR, replace the first item of the above checklist with the
release checklist on the pysat wiki:
https://github.com/pysat/pysat/wiki/Checklist-for-Release

Expanded the format of acceptable JRO azimuth and elevation variable names.
Created unit tests for all of the JRO-specific methods.
Added an example for calculating the JRO ISR beam location.
Added a figure showing the results of adding the geographic beam location to JRO ISR data.
Added section labels to the methods documentation.
Updated the examples index to include the JRO ISR beam calculation example.
Updated the changelog to include a new release section, adding the changes made in this branch.
This was linked to issues Sep 14, 2021
@aburrell aburrell added this to the 0.1.0 Release milestone Sep 14, 2021
@aburrell aburrell added documentation Improvements or additions to documentation enhancement New feature or request testing labels Sep 14, 2021
Copy link
Member

@jklenzing jklenzing left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good. Some suggestions below for consistency across projects.

pysatMadrigal/tests/test_methods_jro.py Outdated Show resolved Hide resolved
pysatMadrigal/tests/test_methods_jro.py Show resolved Hide resolved
pysatMadrigal/tests/test_methods_jro.py Show resolved Hide resolved
pysatMadrigal/tests/test_methods_jro.py Outdated Show resolved Hide resolved
pysatMadrigal/tests/test_methods_jro.py Show resolved Hide resolved
pysatMadrigal/tests/test_methods_jro.py Show resolved Hide resolved
Added `return` to all test methods.

Co-authored-by: Jeff Klenzing <[email protected]>
@aburrell aburrell merged commit cf2bf79 into develop Sep 16, 2021
@aburrell aburrell deleted the doc_calc_meas_loc branch September 16, 2021 10:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request testing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: add more examples TST: Expand instrument method coverage
2 participants